pp108 : Message Repository

Message Repository

This topic describes the message repository.


A message repository is a collection of all the localized log messages defined within the system. All log messages are now a part of the Process Platform Message Code Framework (MCF).

A message in a message repository has a MessageID associated with it. This ID helps identify the message text and description. All messages are defined under a <MessageBundle> which denotes the context of all messages under it. Each <Message> contains the details of a particular message. Message ID must be specified explicitly to guide the administrator or the developer identify such log messages.
Here's an example:

<MessageBundle id="Cordys.ESBServer.Messages">
    <Message id="methodInvoked">
        <MessageText>Invoked the method.</MessageText>
        <Description/>
        <Annotations>
            <DocumentationURL/>
        </Annotations>
    </Message>
    <Message id="methodInvokeError">
        <MessageText>Exeception while invoking the method.</MessageText>
        <Description/>
        <Annotations>
            <DocumentationURL/>
        </Annotations>
    </Message>
</MessageBundle>


The following attributes are used in the message repository file:

Attribute

Description

ID

The ID associated with the message, for defining log messages and identifying them

Message Text

Describes the log messages and provides the solution to fix the error, where necessary

Description

Describes the log messages. This attribute is optional.

Annotations

Contains a link to the detailed description or information on the log message. This attribute is optional.


Related tasks

Generating Alerts
Generating Log Messages from Repository
Publishing Alerts